Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Break intersphinx into a package #12178

Merged
merged 7 commits into from
Apr 25, 2024

Conversation

chrisjsewell
Copy link
Member

This change completely maintains the public API and includes no changes in code logic

Internally though it split the code into three, independent, concerns:

  1. Loading inventory data into an internal representation
  2. Using the internally represented inventories to resolve references
  3. Providing command-line utilities

This makes the logic clearer and more maintainable for future changes

It also remove this module from the ruff format exclude list

@picnixz
Copy link
Member

picnixz commented Mar 22, 2024

This change completely maintains the public API and includes no changes in code logic

I assume that all public functions were re-exported right?

@chrisjsewell
Copy link
Member Author

chrisjsewell commented Mar 22, 2024

I assume that all public functions were re-exported right?

yes, they are all part of __all__ in sphinx/intersphinx/__init__.py

Copy link
Contributor

@jakobandersen jakobandersen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Assuming this basically just moves code around (haven't checked), then I don't see any issues.

@picnixz
Copy link
Member

picnixz commented Apr 4, 2024

I haven't checked again but if nothing changed since I reviewed and if everything that was public is still exported at the same location, I'm fine with that.

Do you want to make another PR where some objects are deprecated and marked as private in 9.x?

@AA-Turner AA-Turner changed the title 🔧 [refactor] Split intersphinx into load/resolve/cli submodules Split intersphinx into load/resolve/cli submodules Apr 9, 2024
chrisjsewell and others added 7 commits April 25, 2024 13:56
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
@chrisjsewell
Copy link
Member Author

@AA-Turner please don't merge this as is yet 😅 ,
I haven't integrated #12193 into the new code

@AA-Turner
Copy link
Member

I haven't integrated #12193 into the new code

I just have; I re-split on your delineations from the current state of intersphinx.py (but kept you as the author / credit via rewriting the commit metadata).

A

@AA-Turner AA-Turner changed the title Split intersphinx into load/resolve/cli submodules Move intersphinx into a package Apr 25, 2024
@AA-Turner AA-Turner changed the title Move intersphinx into a package Break intersphinx into a package Apr 25, 2024
@chrisjsewell
Copy link
Member Author

I just have; I re-split on your delineations from the current state of intersphinx.py (but kept you as the author / credit via rewriting the commit metadata

Ok cool cheers, I didn't see that, just wanted to quickly write something before the CLI finished running 😄

but yeh, as long as we have double-checked that the new code matches the old, then all good from my end 👍

@AA-Turner
Copy link
Member

No worries -- better safe than sorry & all that! I've also broken up the commits that reorganise the package so it's easier to verify that everything has been moved correctly -- and I've deferred any style updates until after this PR, again in an effort to properly verify everything is all well.

A

@chrisjsewell
Copy link
Member Author

perfect 👌

@AA-Turner
Copy link
Member

I intend to rebase-merge this as-is, but if you want me to hold off at all I'm happy to do so @chrisjsewell

@chrisjsewell
Copy link
Member Author

I intend to rebase-merge this as-is, but if you want me to hold off at all I'm happy to do so

No thats great thanks, go ahead!

@AA-Turner AA-Turner merged commit 3439337 into sphinx-doc:master Apr 25, 2024
23 checks passed
@github-actions github-actions bot locked as resolved and limited conversation to collaborators May 26, 2024
@AA-Turner AA-Turner added this to the 7.4.0 milestone Jul 13, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants